package edu.mtu.citizenscience.mushroommapper.json;

import edu.mtu.citizenscience.mushroommapper.json.mushroomnames.Family;

/**
 * @author Corbin Uselton <corbinu@cwuselto@mtu.edu>
 * @copyright (c) 2012 MichiganTech <http://www.mtu.edu>
 * @since 1.0
 * 
 * Mushroom names object used by Jackson JSON to load in
 * the mushrooms.json file
 */
public class MushroomNames {
	// the mushrooms data version
	private int version;
	// array of mushroom families in the mushrooms data file
	private Family[] families;

	/**
	 * Get the mushrooms data version
	 * 
	 * @param   void
	 * @return	int - the data version
	 */
	public int getVersion() 
	{
		return version;
	}
	
	/**
	 * Set the mushrooms data version
	 * 
	 * @param   int - the data version
	 * @return	void
	 */
	public void setVersion(int version) 
	{
		this.version = version;
	}

	/**
	 * Get the mushroom families
	 * 
	 * @param   void
	 * @return	Family[] - the mushroom families
	 */
	public Family[] getFamilies() 
	{
		return families;
	}
	
	/**
	 * Set the mushroom families
	 * 
	 * @param   Family[] - the mushroom families
	 * @return	void
	 */
	public void setFamilies(Family[] families)
	{
		this.families = families;
	}

}
